Skip to content

docs: update USAGE.md with current text format and workflow guides#7

Merged
tobixen merged 3 commits into
mainfrom
docs
Mar 19, 2026
Merged

docs: update USAGE.md with current text format and workflow guides#7
tobixen merged 3 commits into
mainfrom
docs

Conversation

@tobixen
Copy link
Copy Markdown
Member

@tobixen tobixen commented Mar 19, 2026

Summary

  • Fix the --format text section: update the example output and status table to match the actual current multi-line per-feature format, replace old [ok]/[no]/[error] markers with real support level values (full, unsupported, quirk, fragile, broken, unknown), and explain the distinction between "Extra check information" (observed behaviour) and "Description of the feature" (general definition)
  • Add a step-by-step guide for contributing a new server profile to caldav/compatibility_hints.py via a PR to the caldav project
  • Add a guide for storing checker results in ~/.config/caldav/calendar.conf, covering the named-profile, inline-features, and base+overrides patterns

Test plan

  • Read through USAGE.md and verify examples match actual tool output
  • Verify links to caldav project files are correct

🤖 Generated with Claude Code

tobixen and others added 3 commits March 19, 2026 17:06
- Fix --format text example and status table to match actual output
  (multi-line per-feature blocks, real support level values incl. unknown)
- Add guide: contributing a new server profile to caldav/compatibility_hints.py
- Add guide: storing checker results in ~/.config/caldav/calendar.conf
  (named profile, inline features, and base+overrides patterns)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The caldav test server registry now registers servers with capitalised
names (e.g. "Radicale", "Xandikos") after a recent refactor in the
caldav library.  The exact-match lookup therefore failed silently when
users passed lowercase names like --name radicale.

Add a case-insensitive fallback that iterates registry.all_servers()
when the exact key is not found.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ing)

Two bugs prevented --name from finding servers in the caldav test registry:

1. The caldav library capitalised its server names (Radicale, Xandikos).
   The registry lookup now falls back to a case-insensitive search when
   the exact key is not found.

2. The caldav-server-tester's own tests/ package shadows the caldav
   project's tests/test_servers module — either via sys.modules (if
   already imported) or via '' (CWD) in sys.path.  Switch from
   `from tests.test_servers import …` to loading the module directly
   with importlib.util.spec_from_file_location, bypassing sys.path
   resolution entirely.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@tobixen tobixen merged commit 4b35681 into main Mar 19, 2026
12 checks passed
@tobixen tobixen deleted the docs branch March 19, 2026 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant